Configuring Send Gas Quality Commands

For each eligible device the Send Gas Quality command resolves to, the service will send gas quality data to the resolved device.

See FMS Commands and Send Gas Quality for more information about this command.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

See FMS Send Gas Quality Items in the Devices section for more information about the data items supported by CygNet.

Configuring a Send Gas Quality Command

To Configure a Send Gas Quality Command

Open the Command menu in FMS Explorer.
Click Manage to access the FMS Command Definitions dialog box and then click Add to access the Create New FMS Command Definition dialog box.

Create New FMS Command Definition

Create New FMS Command Definition
Send Gas Quality to Device Command

Define the command definition properties.

Type a Name for the command into the text box. Maximum character count is 50.
Select the Command type from the drop-down menu.
Select a processing Priority from the drop-down menu.
Select a Logging level from the drop-down menu, to determine the level of logging details reported when viewing command logs. Options include Low, Medium, and High. See Viewing Command Logs for more information.
Click to select/clear the check box to Prompt when command runs.

Define the command parameters. The parameters for a Send Gas Quality to Device command are described in the Command parameters box, which includes the Description, a Required indicator, and a configurable Value field. Set the value for each required and each desired optional parameter, as indicated in its Value field.

Click Create New. The new command will appear in the list of FMS Command Definitions.

Command Definition Properties

The following command definition properties apply to Send Gas Quality commands.

Property	Description
Name	Type in a Name for the new command.
Command type	Select the desired Command type from the drop-down menu. See FMS Commands for more information about available command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low — displays errors Medium — displays errors and warnings High — displays errors, warnings, and additional information applicable to the command Default value is Low level logging when scheduling a command in the MSS. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer.
Prompt when command runs	Click to select/clear the check box to Prompt when command runs. Selecting this option means you will receive a prompt asking if you want to modify the parameters before the command is executed.

Command Parameters

The following command parameters apply to Send Gas Quality commands when creating or editing commands via FMS Explorer.

Description	Value
Date format	Select the desired date format from the drop-down menu. Options are as follows. Device Contract Local Default value is Device time.
Gas quality timestamp	Will send the gas quality record as of this timestamp down to the device. Click ... to Select Date and Time. See Selecting Date and Time for more information. See Note below this table. This parameter is optional. If not provided, the default value is <current> time.
Skip if succeeded after	Will not execute on devices that have a successful ReqConfig (Request Current Configuration) message after the given timestamp. Click ... to Select Date and Time. See Selecting Date and Time for more information. See Note below this table. This parameter is optional.
Skip if no failure after	Will not execute on devices unless they have a failure on or after the given timestamp. Click ... to Select Date and Time. See Selecting Date and Time for more information. See Note below this table. This parameter is optional.
Status point UDC	If used, the UDC will be combined with the field device facility and the resolved point's status will be updated. Type the status point UDC. This parameter is optional.
Previous request timeout (hours)	If used, the time limit before the request will timeout if it hasn't been completed by the UIS. Each device is only allowed a single outstanding poll (per type) at a time. Type the number of hours. This parameter is optional.
Skip gas analysis if already sent	If used, select Yes or No from the drop-down menu. Yes means records with a "sent" status will not be resent. No means the status will not be considered when sending records. Default value is no. This parameter is optional.
Skip gas analysis with open exceptions	If used, select Yes or No from the drop-down menu. Yes means records with any "open" exceptions will not be sent. No means the exceptions status will not be considered when sending records. Default value is No. This parameter is optional.
Data type to send for each Node	If used, select one of the following options from the drop-down menu and then click OK. Gas analysis (if present), otherwise config GQ Gas analysis (if present), otherwise skip Node The database is first searched for a gas analysis (GA) record. If no GA record is found, the parameter value selected determines whether to use the GQ data record instead, or to skip the Node. See Send Gas Quality Process for more information. This parameter is optional.
Get current configuration prior to send	If used, select Yes or No from the drop-down menu. Yes means current configuration will be requested before records are sent. No means records will be sent without retrieving current configuration records. Default value is No. This parameter is optional.

Note: Date/time — When using relative (rather than absolute) date/time, if both the start and end date/time have hour, minute, and second values of 00 (or if both are set to midnight), an additional day will be added to the date at the end of the range. This occurs because the service assumes the start of the day for the starting date/time and the end of the day for the ending date/time in these circumstances. Therefore requesting a time range from T to T will yield one day of data, and from T-1 to T will yield two days of data. If only one day of data is desired when using relative date/time, the start and end date/times must therefore be the same. If any of the start or end date/time hour, minute, or second values are specified as a value other than zero (or midnight) however, the range will be used as specified.

Editing or Deleting a Send Gas Quality Command

See Managing Node Commands for information about editing or deleting this command.

Running a Send Gas Quality Command

Run Send Gas Quality commands against the Node requiring the data, not against the device providing the data. You can also send this command directly from the Configuration control.

See Using the Configuration Control to Send Gas Quality to a Device for more information.

See Running Node Commands for information about running this command.